<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xilflash: xilflash.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xilflash
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xilflash_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xilflash.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gab4c908ad78f6ded9407d0dc7ed611370"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilflash__apis.html#gab4c908ad78f6ded9407d0dc7ed611370">XFlash_Initialize</a> (XFlash *InstancePtr, u32 BaseAddress, u8 BusWidth, int IsPlatformFlash)</td></tr>
<tr class="memdesc:gab4c908ad78f6ded9407d0dc7ed611370"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function initializes a specific XFlash instance.  <a href="group__xilflash__apis.html#gab4c908ad78f6ded9407d0dc7ed611370">More...</a><br/></td></tr>
<tr class="separator:gab4c908ad78f6ded9407d0dc7ed611370"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacef8005e70142f8113fa163cb5a187f5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilflash__apis.html#gacef8005e70142f8113fa163cb5a187f5">XFlash_Reset</a> (XFlash *InstancePtr)</td></tr>
<tr class="memdesc:gacef8005e70142f8113fa163cb5a187f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function resets the flash device and places it in read mode.  <a href="group__xilflash__apis.html#gacef8005e70142f8113fa163cb5a187f5">More...</a><br/></td></tr>
<tr class="separator:gacef8005e70142f8113fa163cb5a187f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaee7e52b5702a9d346c97ceb56fd4829c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilflash__apis.html#gaee7e52b5702a9d346c97ceb56fd4829c">XFlash_DeviceControl</a> (XFlash *InstancePtr, u32 Command, DeviceCtrlParam *Parameters)</td></tr>
<tr class="memdesc:gaee7e52b5702a9d346c97ceb56fd4829c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to execute device specific commands.  <a href="group__xilflash__apis.html#gaee7e52b5702a9d346c97ceb56fd4829c">More...</a><br/></td></tr>
<tr class="separator:gaee7e52b5702a9d346c97ceb56fd4829c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2b079c7388012f6bdbda754ea0d62641"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilflash__apis.html#ga2b079c7388012f6bdbda754ea0d62641">XFlash_Read</a> (XFlash *InstancePtr, u32 Offset, u32 Bytes, void *DestPtr)</td></tr>
<tr class="memdesc:ga2b079c7388012f6bdbda754ea0d62641"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reads the data from the Flash device and copies it into the specified user buffer.  <a href="group__xilflash__apis.html#ga2b079c7388012f6bdbda754ea0d62641">More...</a><br/></td></tr>
<tr class="separator:ga2b079c7388012f6bdbda754ea0d62641"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadeef4a4805428c7a14578bc0790d6bdc"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilflash__apis.html#gadeef4a4805428c7a14578bc0790d6bdc">XFlash_Write</a> (XFlash *InstancePtr, u32 Offset, u32 Bytes, void *SrcPtr)</td></tr>
<tr class="memdesc:gadeef4a4805428c7a14578bc0790d6bdc"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function programs the flash device(s) with data specified in the user buffer.  <a href="group__xilflash__apis.html#gadeef4a4805428c7a14578bc0790d6bdc">More...</a><br/></td></tr>
<tr class="separator:gadeef4a4805428c7a14578bc0790d6bdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga13e5d44757867a2f424f885ac51890c2"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilflash__apis.html#ga13e5d44757867a2f424f885ac51890c2">XFlash_Erase</a> (XFlash *InstancePtr, u32 Offset, u32 Bytes)</td></tr>
<tr class="memdesc:ga13e5d44757867a2f424f885ac51890c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function erases the specified address range in the flash device.  <a href="group__xilflash__apis.html#ga13e5d44757867a2f424f885ac51890c2">More...</a><br/></td></tr>
<tr class="separator:ga13e5d44757867a2f424f885ac51890c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga61597f564c68519fd4449b9fe6c50339"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilflash__apis.html#ga61597f564c68519fd4449b9fe6c50339">XFlash_Lock</a> (XFlash *InstancePtr, u32 Offset, u32 Bytes)</td></tr>
<tr class="memdesc:ga61597f564c68519fd4449b9fe6c50339"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Locks the blocks in the specified range of the flash device(s).  <a href="group__xilflash__apis.html#ga61597f564c68519fd4449b9fe6c50339">More...</a><br/></td></tr>
<tr class="separator:ga61597f564c68519fd4449b9fe6c50339"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad42077db3972cee5f052a5a5063fe538"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilflash__apis.html#gad42077db3972cee5f052a5a5063fe538">XFlash_Unlock</a> (XFlash *InstancePtr, u32 Offset, u32 Bytes)</td></tr>
<tr class="memdesc:gad42077db3972cee5f052a5a5063fe538"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Unlocks the blocks in the specified range of the flash device(s).  <a href="group__xilflash__apis.html#gad42077db3972cee5f052a5a5063fe538">More...</a><br/></td></tr>
<tr class="separator:gad42077db3972cee5f052a5a5063fe538"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga58e08e78cda5a44e67a7ec99fab303d0"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilflash__apis.html#ga58e08e78cda5a44e67a7ec99fab303d0">XFlash_IsReady</a> (XFlash *InstancePtr)</td></tr>
<tr class="memdesc:ga58e08e78cda5a44e67a7ec99fab303d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function checks the readiness of the device, which means it has been successfully initialized.  <a href="group__xilflash__apis.html#ga58e08e78cda5a44e67a7ec99fab303d0">More...</a><br/></td></tr>
<tr class="separator:ga58e08e78cda5a44e67a7ec99fab303d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
